home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / fduser10.zip / README!.1ST < prev    next >
Text File  |  1992-01-09  |  7KB  |  157 lines
  1.                              -= FDUSER =-
  2.  
  3.                  FrontDoor Log file Analyzer/Reporter
  4.  
  5.                           Copyright(c) 1991:
  6.                           Gordon E. Rasnick
  7.                        Arctic Computer Services
  8.                           2530 Sebring Circle
  9.                          Anchorage, AK  99516
  10.                          All rights reserved.
  11.  
  12.                          FIDONET (1:355/500)
  13.                        CompuServe ID: 72007,417
  14.  
  15.  
  16.         FrontDoor is Copyright 1989-1991 Advanced Engineering sarl
  17.                           All rights reserved.
  18.  
  19.                           *******************
  20.  
  21.      FDUSER is a complete log file analyzer/reporter for version 2.01/2 
  22.      (the non-commercial versions), and version 2.00 (commercial) of the
  23.      FrontDoor email package.  FDUSER currently only works with these 
  24.      versions, but a more generic package is in the works which will be 
  25.      compatible with different versions.
  26.  
  27.      FDUSER will produce more information about your email activities
  28.      than you probably care to know, but is configurable to the point that
  29.      you get only what you want.
  30.  
  31.      Please read the documentation carefully.  It is important that both
  32.      FDUSER and FrontDoor be set up correctly for this system to work
  33.      properly.
  34.  
  35.      FDUSER requires at least 356k of free memory to run, and will use
  36.      any free EMS it finds.  The more free conventional memory (0 - 640k)
  37.      it has, the faster it will run.  During beta testing, FDUSER processed
  38.      FrontDoor log files of 750k in about 4 minutes on a 286/12mhz machine
  39.      with no EMS.  On a 386-25mhz with 8megs of RAM, it processed the same
  40.      file and produced all the reports in less than 2 minutes.
  41.  
  42.      This version of FDUSER is not crippled in any way.  All the features 
  43.      are enabled in this release.  When you first start it up, you will be 
  44.      asked to type in a random number to continue.  It will then perform 
  45.      without any  further intervention.  This random number step will occur 
  46.      each time you run FDUSER until you register your copy and receive a 
  47.      registration key code.  See REGISTER.DOC for more information.  Your 
  48.      registration will disable the random number step, permitting you to 
  49.      run it from your batch file during regular nightly maintainance events.
  50.  
  51.  
  52.                           *******************
  53.  
  54.      GETTING STARTED.
  55.  
  56.      NOTES:  FDUSER must be run from its own directory.  It does not
  57.              search paths for the FDUSER.* files.  Change to the FDUSER
  58.              directory before running this program.
  59.  
  60.              FDUSER does not modify FrontDoors log file in any way.  It
  61.              does however, expect the FrontDoor log file to contain
  62.              certain information.  This may mean that you will have to
  63.              modify your setup in FDSETUP to accomodate this program.
  64.              This is explained in detail in the FDUSER.CFG file.
  65.  
  66.              If you find that you aren't getting what you'd expect out
  67.              of this program, look in the FDUSER directory for a file
  68.              called FDUSER.ERR.  It will be created if trouble arises.
  69.  
  70.  
  71.      1.  Create a directory on your hard disk called FDUSER.
  72.          MD\FDUSER
  73.  
  74.      2.  Copy all the files from this archive to that directory.
  75.          COPY *.* \FDUSER
  76.  
  77.      3.  Edit the FDUSER.CFG file to set up the system for the
  78.          type of reports you wish to produce, and path and filenames.
  79.          FDUSER.CFG is heavily commented and serves as much of the
  80.          documentation for the program.  Read it carefully.
  81.  
  82.      4.  At the DOS prompt type in FDUSER and press return.  FDUSER will
  83.          read in your FrontDoor log file and store the data it will need
  84.          for your reports in a file called FDUSER.DBF.  The FDUSER.DBF file
  85.          is not included in the archive, but will be created during the
  86.          initial run.  Other misc files will be created from time to time.
  87.          Altering or removing any of them will bring unpredictable results.
  88.  
  89.      5.  You may now run FDUSER by passing command line parameters to
  90.          tell it which reports you wish to produce.
  91.  
  92.          FDUSER 1:355/500=JOHN  will produce a detailed report of the
  93.          traffic between you and John at node 1:355/500.  Two reports
  94.          will be produced.  JOHN.IN and JOHN.OUT.  You may use any legal
  95.          file and path name you wish after the "=" sign, but use no
  96.          extension.  FDUSER 1:355/500=C:\BBS\TXTFILES\JOHN would create
  97.          the report in the directory where you keep your bbs displayable
  98.          text files. (C:\BBS\TXTFILES\)
  99.  
  100.          FDUSER -R will produce a single report of all the traffic between
  101.          you and all other nodes you have had contact with.  You can specify
  102.          the filename of this report in the FDUSER.CFG file at the MAIL FILE
  103.          statement.  The filename will always be the same and paths are
  104.          supported here also.
  105.  
  106.          FDUSER -W will wipe out all stored data in the system, in effect,
  107.          giving you a clean slate.  CAREFULL!  There is no escape from this
  108.          switch.   Since you want to be able to run it from your batch file,
  109.          No prompt will be given before the data is removed from the file.
  110.  
  111.  
  112.    Summary:
  113.      You will probably want to call FDUSER several times in a session,
  114.      first to process the latest FrontDoor log, then to create the reports.
  115.  
  116.      I would recommend you use a public domain program I wrote called DAILY.
  117.      Daily will backup all your log files, including FDUSER data files.
  118.      You can FREQ it from me at 1:355/500 (HST) using the magic name DAILY.
  119.      (The latest release of FDUSER is also FREQable as FDUSER.)
  120.  
  121.      A typical session in your batch file might look something like:
  122.  
  123.      :FDU
  124.        CD\FDUSER
  125.         REM   Read in the latest FD log info.
  126.         FDUSER
  127.  
  128.          REM   Produce a report of traffic to and from 1:355/1
  129.          FDUSER 1:355/1=C:\BBS\TXTFILES\PETE
  130.  
  131.           REM   Produce a report of traffic to and from 1:355/5
  132.           FDUSER 1:355/5=C:\BBS\TXTFILES\TODD
  133.  
  134.           REM   DITTO
  135.           FDUSER 1:355/500=C:\BBS\TXTFILES\GORDON
  136.  
  137.           REM   Produce a report for all mail traffic with other nodes.
  138.           FDUSER -R
  139.  
  140.         REM   Wipe out all data being stored by FDUSER.
  141.         FDUSER -W
  142.        
  143.        REM   Make backups of all log files.
  144.        DAILY
  145.       
  146.       REM   Start up BBS/FD again.
  147.       GOTO RECYCLE
  148.  
  149.       The entire run above on a months worth of FD log data would only take
  150.       about 3 mins on a slow machine, but you'll probably want to run this
  151.       on a weekly basis, or more often if you have a busy system.  Mine runs
  152.       every night, but without the call to FDUSER -W.  I have that set up as
  153.       a seperate event occuring once a week, and I have sysop only menus to
  154.       read them all from a bbs logon.
  155.  
  156.  
  157.